Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecate textinput contrast #4991

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Deprecate textinput contrast #4991

wants to merge 8 commits into from

Conversation

CleverLemming1337
Copy link

@CleverLemming1337 CleverLemming1337 commented Sep 19, 2024 •
edited
Loading

Closes #4355

This is my first contribution on this repository. I marked the contrast prop of TextInput and TextInputWithTokens as deprecated. I know that the issue says it should be removed, but for now I just deprecated it.

Changelog

New

Changed

  • Mark contrast of TextInput and TextInputWithTokens as deprecated.

Removed

Rollout strategy

  • Minor (versioning.md says it‘s a minor when a prop is deprecated)

Testing & Reviewing

Merge checklist

@CleverLemming1337 CleverLemming1337 requested a review from a team as a code owner September 19, 2024 16:24
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 19, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: 0b71456

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions GitHub Actions
Copy link
Contributor

Hi! This pull request has been marked as stale because it has been open with no activity for 60 days. You can comment on the pull request or remove the stale label to keep it open. If you do nothing, this pull request will be closed in 7 days.

@github-actions github-actions bot added the Stale label Nov 18, 2024
@github-actions github-actions bot removed the Stale label Nov 21, 2024
@lesliecdubs lesliecdubs removed the request for review from keithamus November 26, 2024 18:52
francinelucca
francinelucca reviewed Dec 3, 2024
View reviewed changes
Copy link
Member

@francinelucca francinelucca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution! Sorry in the delay in getting back with a review 🙏🏼
Mostly LGTM, just wanting to confirm proper deprecation with design (see comment below)

packages/react/src/TextInputWithTokens/TextInputWithTokens.tsx
@@ -79,7 +79,7 @@ function TextInputWithTokensInnerComponent<TokenComponentType extends AnyReactCo
trailingVisual: TrailingVisual,
loading,
loaderPosition = 'auto',
contrast,
contrast, // deprecated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we'd also want to add the @deprecated decorator to the contrast prop in the StyledTextInputBaseWrapperProps object.
Though I do see this is also used in Select in addition to TextInput,TextArea and TextInputWithTokens.
@mperrotti wondering if we're good to remove contrast for all of these or should we explore a different strategy? 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@francinelucca francinelucca francinelucca left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Deprecate and remove the input contrast prop
2 participants
@CleverLemming1337 @francinelucca